Node / meshtastic / Meshtastic-Android / files / .github / workflows / docs-release.yml

Displaying Raw • Download

Tff7b72nameTb4b4b4: Ta5d6ffDocsTa5d6ff Ta5d6ffRelease

Tff7b72onTb4b4b4:

Tff7b72pushTb4b4b4:

Tff7b72tagsTb4b4b4:

Tb4b4b4- Ta5d6ff'Ta5d6ffv*.*.*Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ff!v*-*Ta5d6ff'

Tff7b72permissionsTb4b4b4:

Tff7b72contentsTb4b4b4: Ta5d6ffread

Tff7b72pagesTb4b4b4: Ta5d6ffwrite

Tff7b72id-tokenTb4b4b4: Ta5d6ffwrite

Tff7b72concurrencyTb4b4b4:

Tff7b72groupTb4b4b4: Ta5d6ffpages

Tff7b72cancel-in-progressTb4b4b4: Ta5d6fffalse

Tff7b72jobsTb4b4b4:

Tff7b72buildTb4b4b4:

Tff7b72ifTb4b4b4: Ta5d6ffgithub.repositoryTa5d6ff Ta5d6ff==Ta5d6ff Ta5d6ff'meshtastic/Meshtastic-Android'

Tff7b72runs-onTb4b4b4: Ta5d6ffubuntu-24.04

Tff7b72stepsTb4b4b4:

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffCheckout

Tff7b72usesTb4b4b4: Ta5d6ffactions/checkout@v7.0.0

Tff7b72withTb4b4b4:

Tff7b72submodulesTb4b4b4: Ta5d6fftrue

Tff7b72fetch-depthTb4b4b4: Ta5d6ff0

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffExtractTa5d6ff Ta5d6ffVersion

Tff7b72idTb4b4b4: Ta5d6ffversion

Tff7b72runTb4b4b4: Tb4b4b4|

Tff7b72TAG=${GITHUB_REF#refs/tags/v}

Tff7b72echo "version=$TAG" >> $GITHUB_OUTPUT

Tff7b72echo "Deploying docs for version: $TAG"

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffGradleTa5d6ff Ta5d6ffSetup

Tff7b72usesTb4b4b4: Ta5d6ff./.github/actions/gradle-setup

Tff7b72withTb4b4b4:

Tff7b72gradle_encryption_keyTb4b4b4: Ta5d6ff${{Ta5d6ff Ta5d6ffsecrets.GRADLE_ENCRYPTION_KEYTa5d6ff Ta5d6ff}}

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffSetupTa5d6ff Ta5d6ffRuby

Tff7b72usesTb4b4b4: Ta5d6ffruby/setup-ruby@v1

Tff7b72withTb4b4b4:

Tff7b72ruby-versionTb4b4b4: Ta5d6ff'Ta5d6ff4.0.4Ta5d6ff'

Tff7b72bundler-cacheTb4b4b4: Ta5d6fftrue

Tff7b72working-directoryTb4b4b4: Ta5d6ffdocs

T8b949e# Build root docs site (/ on Pages)

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffBuildTa5d6ff Ta5d6ffRootTa5d6ff Ta5d6ffDocsTa5d6ff Ta5d6ffSite

Tff7b72runTb4b4b4: Ta5d6ff./gradlewTa5d6ff Ta5d6ffgenerateDocsBundleTa5d6ff Ta5d6ffpublishDocsSiteTa5d6ff Ta5d6ff-Pdocs.channel=rootTa5d6ff Ta5d6ff-Pci=true

T8b949e# Build versioned docs (/vX.Y.Z/ on Pages)

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffBuildTa5d6ff Ta5d6ffVersionedTa5d6ff Ta5d6ffDocs

Tff7b72runTb4b4b4: Ta5d6ff./gradlewTa5d6ff Ta5d6ffgenerateDocsBundleTa5d6ff Ta5d6ffpublishDocsSiteTa5d6ff Ta5d6ff-Pdocs.channel=releaseTa5d6ff Ta5d6ff-Pdocs.version=${{Ta5d6ff Ta5d6ffsteps.version.outputs.versionTa5d6ff Ta5d6ff}}Ta5d6ff Ta5d6ff-Pci=true

T8b949e# Build Dokka API reference (/api/ on Pages)

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffBuildTa5d6ff Ta5d6ffDokkaTa5d6ff Ta5d6ffHTMLTa5d6ff Ta5d6ffdocumentation

Tff7b72runTb4b4b4: Ta5d6ff./gradlewTa5d6ff Ta5d6ffdokkaGeneratePublicationHtmlTa5d6ff Ta5d6ff--no-configuration-cache

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffCompileTa5d6ff Ta5d6ffJekyllTa5d6ff Ta5d6ffSites

Tff7b72runTb4b4b4: Tb4b4b4|

Tff7b72# Build versioned Jekyll site

Tff7b72BUNDLE_GEMFILE=docs/Gemfile bundle exec jekyll build \

Tff7b72--source build/_site/v${{ steps.version.outputs.version }} \

Tff7b72--destination build/jekyll_release \

Tff7b72--baseurl /${{ github.event.repository.name }}/v${{ steps.version.outputs.version }}

Tff7b72# Move versioned source folder out of root source folder to avoid nested build issues

Tff7b72mv build/_site/v${{ steps.version.outputs.version }} build/v_temp

Tff7b72# Build root Jekyll site

Tff7b72BUNDLE_GEMFILE=docs/Gemfile bundle exec jekyll build \

Tff7b72--source build/_site \

Tff7b72--destination build/jekyll_root \

Tff7b72--baseurl /${{ github.event.repository.name }}

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffAssembleTa5d6ff Ta5d6ffPagesTa5d6ff Ta5d6ffartifact

Tff7b72runTb4b4b4: Tb4b4b4|

Tff7b72# Create final site directory

Tff7b72mkdir -p build/final_site

Tff7b72# Copy root compiled site

Tff7b72cp -r build/jekyll_root/* build/final_site/

Tff7b72# Copy release compiled site to vX.Y.Z/

Tff7b72mkdir -p build/final_site/v${{ steps.version.outputs.version }}

Tff7b72cp -r build/jekyll_release/* build/final_site/v${{ steps.version.outputs.version }}/

Tff7b72# Copy Dokka output into final_site/api/

Tff7b72cp -r build/dokka/html build/final_site/api

Tff7b72# Disable GitHub Pages' own Jekyll build

Tff7b72touch build/final_site/.nojekyll

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffUploadTa5d6ff Ta5d6ffPagesTa5d6ff Ta5d6ffArtifact

Tff7b72usesTb4b4b4: Ta5d6ffactions/upload-pages-artifact@v5

Tff7b72withTb4b4b4:

Tff7b72pathTb4b4b4: Ta5d6ffbuild/final_site/

Tff7b72deployTb4b4b4:

Tff7b72ifTb4b4b4: Ta5d6ffgithub.repositoryTa5d6ff Ta5d6ff==Ta5d6ff Ta5d6ff'meshtastic/Meshtastic-Android'

Tff7b72needsTb4b4b4: Ta5d6ffbuild

Tff7b72runs-onTb4b4b4: Ta5d6ffubuntu-24.04-arm

Tff7b72environmentTb4b4b4:

Tff7b72nameTb4b4b4: Ta5d6ffgithub-pages

Tff7b72urlTb4b4b4: Ta5d6ff${{Ta5d6ff Ta5d6ffsteps.deployment.outputs.page_urlTa5d6ff Ta5d6ff}}

Tff7b72stepsTb4b4b4:

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffDeployTa5d6ff Ta5d6fftoTa5d6ff Ta5d6ffGitHubTa5d6ff Ta5d6ffPages

Tff7b72idTb4b4b4: Ta5d6ffdeployment

Tff7b72usesTb4b4b4: Ta5d6ffactions/deploy-pages@v5